/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.pushanalysis;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import com.google.common.base.MoreObjects;
import java.util.HashSet;
import java.util.Set;
import org.hisp.dhis.common.BaseIdentifiableObject;
import org.hisp.dhis.common.DxfNamespaces;
import org.hisp.dhis.common.MetadataObject;
import org.hisp.dhis.dashboard.Dashboard;
import org.hisp.dhis.user.UserGroup;

/**
 * PushAnalysis generates reports based on a Dashboard, and sends them to UserGroups at given
 * Intervals.
 *
 * @author Stian Sandvold
 */
@JacksonXmlRootElement(localName = "pushanalysis", namespace = DxfNamespaces.DXF_2_0)
public class PushAnalysis extends BaseIdentifiableObject implements MetadataObject {
  /** PushAnalysis uses a dashboard to base it's reports on */
  private Dashboard dashboard;

  /** Title of the report. Will be at the top of each report */
  private String title;

  /** The message will be written in the report. Used to explain or describe reports to users */
  private String message;

  /** PushAnalysis reports are sent to one or more userGroups */
  private Set<UserGroup> recipientUserGroups = new HashSet<>();

  private boolean enabled;

  private Integer schedulingDayOfFrequency;

  private SchedulingFrequency schedulingFrequency;

  public PushAnalysis() {}

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public Dashboard getDashboard() {
    return dashboard;
  }

  public void setDashboard(Dashboard dashboard) {
    this.dashboard = dashboard;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public Set<UserGroup> getRecipientUserGroups() {
    return recipientUserGroups;
  }

  public void setRecipientUserGroups(Set<UserGroup> recipientUserGroups) {
    this.recipientUserGroups = recipientUserGroups;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public String getMessage() {
    return message;
  }

  public void setMessage(String message) {
    this.message = message;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public String getTitle() {
    return title;
  }

  public void setTitle(String title) {
    this.title = title;
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("dashboard", dashboard)
        .add("title", title)
        .add("message", message)
        .add("recipientUserGroups", recipientUserGroups)
        .toString();
  }

  // Deprecated since 2.29
  public SchedulingFrequency getSchedulingFrequency() {
    return schedulingFrequency;
  }

  public void setSchedulingFrequency(SchedulingFrequency schedulingFrequency) {
    this.schedulingFrequency = schedulingFrequency;
  }

  public Integer getSchedulingDayOfFrequency() {
    return schedulingDayOfFrequency;
  }

  public void setSchedulingDayOfFrequency(Integer schedulingDayOfFrequency) {
    this.schedulingDayOfFrequency = schedulingDayOfFrequency;
  }

  public boolean getEnabled() {
    return enabled;
  }

  public void setEnabled(boolean enabled) {
    this.enabled = enabled;
  }
}
